home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / msgtos20.zip / SPAZ_150.LZH / SPAZ.DOC < prev    next >
Text File  |  1990-10-07  |  9KB  |  256 lines
  1.     ------------------------------------------------------------------
  2.     
  3.                                 SPAZ 1.50
  4.                              October 7, 1990
  5.  
  6.             By Dan Thomson, Andrew Farmer and Jeffrey Nonken.
  7.  
  8.  
  9.                                USER MANUAL
  10.  
  11.  
  12.           Copyright (c) 1989-1990 Dan Thomson and Andrew Farmer.
  13.                           All Rights Reserved.
  14.  
  15.     ------------------------------------------------------------------
  16.  
  17.     --------------------
  18.      THE LEGAL BUSINESS 
  19.     --------------------
  20.  
  21.     Spaz is guaranteed only to take up space on your hard disk.  Use
  22.     it at your own risk. No warranty is stated or implied. The
  23.     authors shall not be responsible for any damages resulting  from
  24.     it's  use, directly or indirectly.
  25.  
  26.     Spaz is distributed as a Freely Available Copyrighted Program,
  27.     no fee may be charged for distribution and the distribution
  28.     archive is not to be tampered with or altered in ANY way.
  29.  
  30.     Spaz cannot be distributed in a modified form of any sort.
  31.  
  32.     Modified Source code, likewise, may NOT be distributed. If  you
  33.     are planning on porting the code to another operating system, or
  34.     have code changes that you think are highly beneficial, then
  35.     please contact  the authors directly for assistance or guidance.
  36.  
  37.     While Spaz is freely available  for use in non-corporate
  38.     environments, donations to the authors will always be gratefully
  39.     accepted.
  40.  
  41.     The Authors may be contacted at the following network addresses:
  42.  
  43.                 Dan Thomson     1:163/115.3@fidonet
  44.                 Andrew Farmer   1:163/115.0@fidonet
  45.                 Jeffrey Nonken  1:273/715.0@fidonet
  46.  
  47.  
  48.     -----------------------------------------
  49.      THE DISTRIBUTION ARCHIVE (SPAZ_150.ZIP) 
  50.     -----------------------------------------
  51.  
  52.       This archive should have included the following files:
  53.  
  54.       SPAZ.DOC      -  The Documentation, you read it as we speak.
  55.       SPAZ.NEW      -  Changes since 1.40.
  56.       SPAZ.COM      -  The Executable Program.
  57.       SPAZ.ASM      -  The Complete Assembler Source Code.
  58.  
  59.  
  60.     --------------
  61.      WHAT IT DOES 
  62.     --------------
  63.  
  64.     Spaz checks the archive to determine it's type, sorts the
  65.     contents by date/time to ensure proper mail distribution and
  66.     calls the appropriate unarchive  program to extract the contents.
  67.     If you use the /N command line option, the Sorting will NOT
  68.     occur.
  69.  
  70.     Spaz is idealy suited to netmail activities where it can auto
  71.     detect incoming archives and extract them transparent to the
  72.     calling program.
  73.     
  74.     If the Archive is a standard (ARC compatible) Archive, it will
  75.     search first for Pkxarc, then PkUnPak, Pak and ArcE in that
  76.     order, until it finds one on the path. If you use the /A
  77.     command line option, then ArcE will be used exclusively..no
  78.     other program will be searched for.
  79.  
  80.     If the Archive contains Crushed or Distilled files, as created by
  81.     the Pak Program, Spaz will not attempt to use any other
  82.     Un-Archiver it will simply search for and use Pak.
  83.  
  84.     If the Archive was created by ZOO Spaz will search first for Looz
  85.     and then for Zoo, in that order, until it finds one on the path.
  86.  
  87.     If the Archive was created by DWC, then Spaz will not attempt to
  88.     use any other Un-Archiver it will simply search for and use DWC.
  89.      
  90.     If the Archive was created by PKZIP, then Spaz will not attempt
  91.     to use any other Un-Archiver it will simply search for and use
  92.     PkZip.
  93.  
  94.     If the Archive was created by LHARC, then Spaz will not attempt
  95.     to use any other Un-Archiver it will simply search for and use
  96.     LHARC.
  97.  
  98.     NOTE: SPAZ can be renamed to ARCE.COM to be used with OPUS 1.03,
  99.     or it can be used with Confmail by using the '/A SPAZ' option. If
  100.     you rename Spaz to ArcE be sure to have one of the other
  101.     un-archivers on the Path, (and  don't use the /A switch)
  102.     otherwise Spaz would be calling ArcE, which would be itself so
  103.     you'd have an endless loop on your hands.
  104.  
  105.     SPAZ can also be used in a batch file (multitasking systems) as
  106.     it understands wildcard filenames.  This will remove the memory
  107.     overhead of having Confmail shell to an Unarchiver. If used with
  108.     the /D option, spaz will even delete the archives once processed
  109.     (if the extract was successful.
  110.      
  111.  
  112.     ------------------------------
  113.      DISK AND MEMORY REQUIREMENTS
  114.     ------------------------------
  115.  
  116.      1. DOS 2.11 or greater.
  117.      2. Enough disk space for a 2nd copy of the archive to be processed.
  118.      3. At least 16K of RAM, plus room to load the Un-Archiver.
  119.      4. At least 2 available handles. (files= statement in config.sys).
  120.  
  121.  
  122.     ---------------------
  123.      COMMAND LINE SYNTAX 
  124.     ---------------------
  125.  
  126.      Usage:  SPAZ [switches] Path/Archive [switches] [file...] [file...]
  127.  
  128.      Items enclosed in Square Brackets ([]) are entirely optional.
  129.  
  130.      Switches:
  131.  
  132.         *  -A
  133.  
  134.            Causes Spaz to search for ArcE (and ONLY ArcE) when
  135.            un-archiving a standard Arc Compatible Archive.
  136.  
  137.         *  -D
  138.  
  139.            Causes Spaz to delete the Archive once Extract is
  140.            successful. By default it is NOT deleted.
  141.  
  142.         *  -F
  143.  
  144.            Causes Spaz to unpack ONLY Network Compressed Mail bundles
  145.            in the specified directory.  It will look for .MO?,.TU?,
  146.            etc. files and unpacked them all into the default
  147.            directory.
  148.  
  149.            When this switch is used the Archive name as specified on
  150.            the the command line should be the Path to your Inbound
  151.            area, NOT a FileName.
  152.  
  153.            The -D (Delete) and -O (Overwrite) switches are forces ON
  154.            by the use of the -F switch.  Likewise the -N (NoSort)
  155.            switch is forced OFF.
  156.  
  157.            Due to the lack of an Overwrite mode in Looz, if this
  158.            switch is used only Zoo will be called to process Zoo
  159.            Archives, NEVER Looz.
  160.  
  161.         *  -Maddress
  162.  
  163.            Causes Spaz to expand the name of each file, and try to
  164.            gleen the sending Net/Node address.  This switch will, or
  165.            course, only work properly on Compressed Mail bundles
  166.            coming in over the Net.
  167.  
  168.            This switch must be followed by the 'address' pararmeter,
  169.            which should be YOUR Net/Node address.
  170.  
  171.         *  -N 
  172.  
  173.            Causes the Archive Sort NOT to be performed.  Since the
  174.            sort doesn't take up much more memory, it  is strongly
  175.            suggested that you DO NOT use this switch for NetMail
  176.            related tasks.
  177.  
  178.         *  -O or -R
  179.  
  180.            Causes Spaz to run in Overwrite Mode.  You will NOT be
  181.            prompted if a file with the same name as that being
  182.            extracted already exists in the directory,  the existing
  183.            file will simply be overwritten.
  184.  
  185.            Due to the lack of an Overwrite mode in Looz, if this
  186.            switch is used only Zoo will be called to process Zoo
  187.            Archives, NEVER Looz.
  188.  
  189.         *  -V
  190.  
  191.            Cause Spaz to run off at the mouth.  Displays run-time
  192.            configuration settings.
  193.  
  194.  
  195.      ----------
  196.       EXAMPLES
  197.      ----------
  198.  
  199.         *  Spaz -D 02986534.MO1
  200.  
  201.            This would sort, then un-archive the bundle and delete it
  202.            when finished.
  203.  
  204.         *  Spaz -N 02986534.MO1
  205.  
  206.            This would Un-Archive the bundle but would not attempt
  207.            to sort them and would not delete when finished.
  208.  
  209.         *  Spaz -D -N *.MO?
  210.  
  211.            This would process all files matching the wildcard specs
  212.            but would not attempt to sort them and would delete when
  213.            finished.
  214.  
  215.         *  Spaz -N HELLO.ARC -Q *.TXT -O
  216.  
  217.            This would only extract files with an extension of TXT, it
  218.            would not sort the archive, it would operate in quiet mode
  219.            & overwrite mode would be used.
  220.  
  221.         *  Spaz -F D:\BINK\INBOUND
  222.  
  223.            This would Sort, extract from, then delete any file
  224.            matching the description of a Standard FidoNet<tm>
  225.            Compressed Mail bundle.
  226.  
  227.         *  Spaz -F -M163/115 D:\BINK\INBOUND
  228.  
  229.            On 163/115 this would Sort, extract from then delete any
  230.            file matching the description  of a FidoNet<tm> Compressed
  231.            Mail bundle.  It would also tell me what node sent the
  232.            bundle.
  233.  
  234.  
  235.         ---------------------=*[ IMPORTANT WARNING ]*=----------------
  236.  
  237.         *  Spaz -D HELLO.ARC *.EXE
  238.  
  239.            This would only extract files with an extension of EXE, it
  240.            would then DELETE THE ENTIRE ARCHIVE. Be extreamly careful
  241.            with the -D switch if you are only extracting specific
  242.            files.
  243.  
  244.  
  245.      ----------------
  246.       CLOSING NATTER 
  247.      ----------------
  248.  
  249.      If you have any problems you can't fix or questions you can't
  250.      answer then please contact one of us via NetMail.  We will
  251.      always do our best to support the software, but it is, by
  252.      definition un-supported. We will answer queries as time allows,
  253.      please be patient when awaiting a reply.
  254.  
  255.      ----------------------------------------------------------------------
  256.